/**
**************************************************************************************
*Founder Effect                                                                      *
*Copyright (C) 2006-2007, 5d Studios (www.5d-Studios.com)                            *
*                                                                                    *
*This library is free software; you can redistribute it and/or                       *
*modify it under the terms of the GNU Lesser General Public                          *
*License as published by the Free Software Foundation; either                        *
*version 2.1 of the License, or (at your option) any later version.                  *
*                                                                                    *
*This library is distributed in the hope that it will be useful,                     *
*but WITHOUT ANY WARRANTY; without even the implied warranty of                      *
*MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU                   *
*Lesser General Public License for more details.                                     *
*                                                                                    *
*You should have received a copy of the GNU Lesser General Public                    *
*License along with this library; if not, write to the Free Software                 *
*Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA      *
**************************************************************************************
*/
#pragma once
#include <string>

/**
 * An interface to a scripting engine 
 */
class IScriptEngine
{
public:
    IScriptEngine(void) {};
    /** Init the scripting engine */
    virtual int Init()=0;
    /** Close off the engine */
    virtual void Shutdown()=0;
    
    /** Execute a file */
    virtual int RunFile(const std::string &filename)=0;
    /** Call a script function */
    virtual void CallFunction(const std::string &name)=0;

    /** Set a global integer */
    virtual void SetGlobalInt(const std::string name, const int val) {};
    /** Set a global double */
    virtual void SetGlobalDouble(const std::string name, const double val) {};
    /** Set a global string */
    virtual void SetGlobalString(const std::string name, const std::string val) {};
    /** Retrieve the global int */
    virtual int  GetGlobalInt(const std::string name) { return 0;}
    /** Retrieve the global double */
    virtual double GetGlobalDouble(const std::string name) { return 0.0f;}
    /** Retrieve the global string */
    virtual const std::string GetGlobalString(const std::string name) { return NULL;}

    /** Get the implementation name */
    virtual const std::string GetImplementation() { return "Dummy"; }

public:
    virtual ~IScriptEngine(void){};
};
